CRM360° CustomerApi Documentation
Return to Odata Help Page

Customer - LoyaltyCard

LoyaltyCard entities

Required HTTP Headers

  • X-Crm360Api-Token
  • X-Crm360Api-CustomerName
  • X-Crm360Api-DatabaseAlias

Functions

Entity Properties

Name Type Is Mandatory
LoyaltyCardId Int32
LoyaltyCardCode String
ContactId Int32
LoyaltyCardCodeTypeId Int16
LoyaltyCardTypeId Int16
LoyaltyCardStateId Int16
FreeField1 String
FreeField2 String
FreeField3 String
FreeField4 String
FreeField5 String
FreeFieldDateTime1 DateTime
FreeFieldDateTime2 DateTime
FreeFieldDateTime3 DateTime
FreeFieldDateTime4 DateTime
FreeFieldDateTime5 DateTime
FreeFieldNumber1 Decimal
FreeFieldNumber2 Decimal
FreeFieldNumber3 Decimal
FreeFieldNumber4 Decimal
FreeFieldNumber5 Decimal
FreeFieldBoolean1 Boolean
FreeFieldBoolean2 Boolean
FreeFieldBoolean3 Boolean
FreeFieldBoolean4 Boolean
FreeFieldBoolean5 Boolean
BrandId Int32
ValidityStartDate DateTime
ValidityEndDate DateTime
DeletionFlag Boolean
StoreId Int32
AdvertiserCreationDate DateTime
SourceId Int16
Contact Contact
Brand Brand
LoyaltyCardType LoyaltyCardType
LoyaltyCardCodeType LoyaltyCardCodeType
LoyaltyCardState LoyaltyCardState
LoyaltyCardActions Collection of LoyaltyCardAction
LoyaltyPoints Collection of LoyaltyPoint
Store Store
PurchaseHeaders Collection of PurchaseHeader
Vouchers Collection of Voucher
Source Source

Actions

Action Name Method Parameters Description Return
SumLoyaltyPoint POST
  • column (String)
  • loyaltyPointTypeId (Int32)
  • loyaltyCardTypeId (Int32)
  • brandId (Int32)
 Compute Sum of chosen column of related LoyaltyPoint entities Decimal 
Example
https://customerapi.fts-crm360.com/data/LoyaltyCards(32)/SumLoyaltyPoint?column=Amount&loyaltyPointTypeId=1&loyaltyCardTypeId=2&brandId=1


HttpMethod : POST
                                                                                       

Informations : 
           - column = PointAmount | PointOriginalAmount | PointUsedAmount | PointExpiredAmount
            - loyaltyPointTypeId is optional
            - loyaltyCardTypeId is optional
            - brandId is optional

Examples

Select all LoyaltyCards
https://customerapi.fts-crm360.com/data/LoyaltyCards()


HttpMethod : GET
                                                                                       

Json Result : 

[
{
"LoyaltyCardId" : "42",
"LoyaltyCardCode" : "YXB CEezBNZDkUsgi",
"ContactId" : "8",
"LoyaltyCardCodeTypeId" : "9",
"LoyaltyCardTypeId" : "6",
"LoyaltyCardStateId" : "7",
"FreeField1" : "idLlclVh",
"FreeField2" : "GgtVz SWFa",
"FreeField3" : "51k0 w0lsoaxBJ",
"FreeField4" : "obn4de0Rh194g",
"FreeField5" : "t3METr3W",
"FreeFieldDateTime1" : "2000-08-22T00:00:00",
"FreeFieldDateTime2" : "2016-01-25T00:00:00",
"FreeFieldDateTime3" : "2018-03-18T00:00:00",
"FreeFieldDateTime4" : "2017-09-21T00:00:00",
"FreeFieldDateTime5" : "2020-06-29T00:00:00",
"FreeFieldNumber1" : "7777295.695",
"FreeFieldNumber2" : "5241336.891",
"FreeFieldNumber3" : "5956982.733",
"FreeFieldNumber4" : "9276168.289",
"FreeFieldNumber5" : "1684789.761",
"FreeFieldBoolean1" : "True",
"FreeFieldBoolean2" : "False",
"FreeFieldBoolean3" : "True",
"FreeFieldBoolean4" : "True",
"FreeFieldBoolean5" : "False",
"BrandId" : "82",
"ValidityStartDate" : "1999-06-01T00:00:00",
"ValidityEndDate" : "2000-05-03T00:00:00",
"DeletionFlag" : "True",
"StoreId" : "34",
"AdvertiserCreationDate" : "2021-04-24T00:00:00",
"SourceId" : "7"
},
{
"LoyaltyCardId" : "37",
"LoyaltyCardCode" : "hZdw5tfX9B 1GH",
"ContactId" : "90",
"LoyaltyCardCodeTypeId" : "1",
"LoyaltyCardTypeId" : "9",
"LoyaltyCardStateId" : "4",
"FreeField1" : "OnAUCR",
"FreeField2" : "bmccCSOI",
"FreeField3" : "QYHw2hP6xrht QnY",
"FreeField4" : "HAgEadpQ34f9rm8",
"FreeField5" : "os qNsXFh",
"FreeFieldDateTime1" : "2005-12-26T00:00:00",
"FreeFieldDateTime2" : "2017-09-07T00:00:00",
"FreeFieldDateTime3" : "2011-11-30T00:00:00",
"FreeFieldDateTime4" : "2008-04-28T00:00:00",
"FreeFieldDateTime5" : "2005-09-07T00:00:00",
"FreeFieldNumber1" : "8166124.296",
"FreeFieldNumber2" : "1664481.977",
"FreeFieldNumber3" : "6967546.451",
"FreeFieldNumber4" : "7185144.158",
"FreeFieldNumber5" : "9572661.177",
"FreeFieldBoolean1" : "False",
"FreeFieldBoolean2" : "False",
"FreeFieldBoolean3" : "False",
"FreeFieldBoolean4" : "True",
"FreeFieldBoolean5" : "True",
"BrandId" : "91",
"ValidityStartDate" : "2011-03-04T00:00:00",
"ValidityEndDate" : "2022-02-15T00:00:00",
"DeletionFlag" : "True",
"StoreId" : "67",
"AdvertiserCreationDate" : "2009-06-15T00:00:00",
"SourceId" : "9"
},
...
]
            
                                                     

Select LoyaltyCard by Id
https://customerapi.fts-crm360.com/data/LoyaltyCards(42)


HttpMethod : GET
                                                                                       

Json Result : 

{
"LoyaltyCardId" : "64",
"LoyaltyCardCode" : "4 wGR9b6Z4zKKXK1Ym",
"ContactId" : "74",
"LoyaltyCardCodeTypeId" : "8",
"LoyaltyCardTypeId" : "7",
"LoyaltyCardStateId" : "9",
"FreeField1" : "I J4c70X",
"FreeField2" : "2Ri16vsR  43huJtQ",
"FreeField3" : "1L J tnSH",
"FreeField4" : "9 jhzX",
"FreeField5" : "Fm c2BgSe",
"FreeFieldDateTime1" : "2007-02-13T00:00:00",
"FreeFieldDateTime2" : "2002-10-30T00:00:00",
"FreeFieldDateTime3" : "2003-08-02T00:00:00",
"FreeFieldDateTime4" : "2007-10-16T00:00:00",
"FreeFieldDateTime5" : "2017-10-27T00:00:00",
"FreeFieldNumber1" : "7765897.383",
"FreeFieldNumber2" : "6663484.124",
"FreeFieldNumber3" : "1138923.853",
"FreeFieldNumber4" : "4174331.114",
"FreeFieldNumber5" : "6878834.386",
"FreeFieldBoolean1" : "True",
"FreeFieldBoolean2" : "False",
"FreeFieldBoolean3" : "True",
"FreeFieldBoolean4" : "True",
"FreeFieldBoolean5" : "True",
"BrandId" : "65",
"ValidityStartDate" : "2007-11-03T00:00:00",
"ValidityEndDate" : "2017-07-01T00:00:00",
"DeletionFlag" : "False",
"StoreId" : "66",
"AdvertiserCreationDate" : "2015-08-11T00:00:00",
"SourceId" : "8"
}
            
                                                     

Create a LoyaltyCard
https://customerapi.fts-crm360.com/data/LoyaltyCards()


HttpMethod : POST
                                                                                                

Json Post :
{
"LoyaltyCardCode" : "g1m6RDH1UCx OUc9",
"ContactId" : "74",
"LoyaltyCardCodeTypeId" : "7",
"LoyaltyCardTypeId" : "1",
"LoyaltyCardStateId" : "1",
"FreeField1" : "RK4sok3QeVswBQ6NTJ",
"FreeField2" : "uwsHUKc",
"FreeField3" : "7vx7k05Oqs",
"FreeField4" : "neOk0tED",
"FreeField5" : "Dgwaj6R",
"FreeFieldDateTime1" : "1998-01-23T00:00:00",
"FreeFieldDateTime2" : "2012-06-03T00:00:00",
"FreeFieldDateTime3" : "1996-05-11T00:00:00",
"FreeFieldDateTime4" : "2012-11-15T00:00:00",
"FreeFieldDateTime5" : "2011-07-30T00:00:00",
"FreeFieldNumber1" : "2395742.921",
"FreeFieldNumber2" : "3515752.843",
"FreeFieldNumber3" : "1334944.668",
"FreeFieldNumber4" : "7627533.123",
"FreeFieldNumber5" : "9211334.137",
"FreeFieldBoolean1" : "False",
"FreeFieldBoolean2" : "True",
"FreeFieldBoolean3" : "True",
"FreeFieldBoolean4" : "True",
"FreeFieldBoolean5" : "False",
"BrandId" : "89",
"ValidityStartDate" : "2024-10-10T00:00:00",
"ValidityEndDate" : "2010-08-28T00:00:00",
"DeletionFlag" : "False",
"StoreId" : "36",
"AdvertiserCreationDate" : "1995-07-26T00:00:00",
"SourceId" : "5"
}
            


Informations : 
 - Non mandatory fields are optional for Json Post
                                                     

Update a LoyaltyCard
https://customerapi.fts-crm360.com/data/LoyaltyCards(42)


HttpMethod : PUT
                                                                                                

Json Post :
{
"LoyaltyCardId" : "37",
"LoyaltyCardCode" : "WnZ CaMFv",
"ContactId" : "9",
"LoyaltyCardCodeTypeId" : "3",
"LoyaltyCardTypeId" : "9",
"LoyaltyCardStateId" : "2",
"FreeField1" : "Jw UZy49",
"FreeField2" : "xOjQxiwTewxrn 6  jz",
"FreeField3" : "hCcsvWwWrCkZXnnKdK",
"FreeField4" : "9xyM hg6DUkNE",
"FreeField5" : "ctx1g",
"FreeFieldDateTime1" : "2008-02-03T00:00:00",
"FreeFieldDateTime2" : "2019-03-10T00:00:00",
"FreeFieldDateTime3" : "2007-04-16T00:00:00",
"FreeFieldDateTime4" : "2013-09-04T00:00:00",
"FreeFieldDateTime5" : "2008-07-25T00:00:00",
"FreeFieldNumber1" : "2431275.623",
"FreeFieldNumber2" : "9733328.834",
"FreeFieldNumber3" : "5434294.669",
"FreeFieldNumber4" : "7624112.573",
"FreeFieldNumber5" : "8918175.563",
"FreeFieldBoolean1" : "False",
"FreeFieldBoolean2" : "False",
"FreeFieldBoolean3" : "True",
"FreeFieldBoolean4" : "True",
"FreeFieldBoolean5" : "True",
"BrandId" : "83",
"ValidityStartDate" : "1996-07-27T00:00:00",
"ValidityEndDate" : "2024-05-20T00:00:00",
"DeletionFlag" : "True",
"StoreId" : "30",
"AdvertiserCreationDate" : "2005-09-23T00:00:00",
"SourceId" : "9"
}
            


Informations : 
 - Non mandatory fields are optional for Json Post
                                                     

Patch a LoyaltyCard
https://customerapi.fts-crm360.com/data/LoyaltyCards(42)


HttpMethod : PATCH
                                                                                                

Json Post :
{
"BrandId" : "99",
"FreeFieldDateTime2" : "2000-02-15T00:00:00",
"FreeFieldDateTime3" : "2010-05-19T00:00:00",
"ContactId" : "39",
"ValidityEndDate" : "2012-11-15T00:00:00",
"LoyaltyCardCodeTypeId" : "9",
"LoyaltyCardTypeId" : "3"
}
            


Informations : 
 - Non mandatory fields are optional for Json Post
                                                     

Delete a LoyaltyCard
https://customerapi.fts-crm360.com/data/LoyaltyCards(42)


HttpMethod : DELETE